/**
 * Copyright 2012 Roger Cockshutt
 * krakenbrau@gmail.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.googlecode.libspml;

/**
 * @author Roger Cockshutt
 * 
 *	Classes implementing the ITokenParser interface process a raw input string (or series of strings),
 *	and extract valid tokens from it.
 *
 */
public interface ITokenProvider {
	
	/**
	 * @author Roger Cockshutt
	 *
	 * Token types.
	 */
	public static enum Type {
		IDENTIFIER				("[^\\<\\>@\\|#:\\s]+"),
		DECLARATOR_SCOPE		("\\<@"),
		DECLARATOR_OBJECT		("\\<\\|"),
		DECLARATOR_PROPERTY		("\\<#"),
		DECLARATOR_VALUE		(":"),
		TERMINATOR_SCOPE		("@\\>"),
		TERMINATOR_OBJECT		("\\|\\>"),
		TERMINATOR_PROPERTY		("#\\>"),
		;
		
		public final String _regex;
		
		private Type(String regex) {
			this._regex = regex;
		}
		
		public AbstractToken makeToken(String literal) {
			return new AbstractToken(this, literal) {};
		}
	}
	
	/**
	 * This method accepts any number of Strings as input and returns a List of ITokens,
	 * extracted according to the ITokenParser's implementation.
	 * 
	 * @param strings Raw input string(s)(lines?)
	 * @return Extracted tokens.
	 */
	public java.util.List<? extends AbstractToken> getTokens(String... strings);
	
	
	
	/**
	 * This method accepts an instance of BufferedReader as input and returns a List of ITokens,
	 * extracted according to the ITokenParser's implementation.
	 * 
	 * @param reader The BufferedReader to read lines from.
	 * @return Extracted tokens.
	 */
	public java.util.List<? extends AbstractToken> getTokens(java.io.BufferedReader reader);
	
	
	
	/**
	 * This method accepts an instance of Path as input and returns a List of ITokens,
	 * extracted according to the ITokenParser's implementation.
	 * 
	 * @param reader The file path describing the SPML file to read from.
	 * @return Extracted tokens.
	 */
	public java.util.List<? extends AbstractToken> getTokens(String filePath);


}
